Skip to content

fix: ComponentLinks were not deleted when parent container was deleted#38821

Open
bradenmacdonald wants to merge 2 commits into
openedx:masterfrom
open-craft:braden/38820-fix-componentlink-on-container-delete
Open

fix: ComponentLinks were not deleted when parent container was deleted#38821
bradenmacdonald wants to merge 2 commits into
openedx:masterfrom
open-craft:braden/38820-fix-componentlink-on-container-delete

Conversation

@bradenmacdonald

@bradenmacdonald bradenmacdonald commented Jun 26, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Description

Fixes #38820

Bug description:

From my investigation, it appears that when the unit is deleted, the corresponding entry is removed from the ContainerLink table as expected, but the associated entries in the ComponentLink table are not removed. As a result, these component links remain in the system even though their downstream usage (the unit) no longer exists in the modulestore.

Explanation: The reason this was happening is that the handler that listens for the item_deleted signal tries to load the deleted item and then delete the ComponentLink entries for each of its children. However, since the item is already deleted, it fails to load the item's children and then fails silently.

openedx-platform/cms/djangoapps/contentstore/signals/handlers.py

Lines 211 to 216 in 17d8ef7

try:
deleted_block = modulestore().get_item(usage_key)
except ItemNotFoundError:
return
id_list = {deleted_block.location}
for block in yield_dynamic_block_descendants(deleted_block, kwargs.get('user_id')):

The simple fix is to use the pre_item_delete signal instead of the item_deleted signal.

Testing instructions

Find a unit in a library that contains at least one component.
Link that unit into a course.
Modify the unit's components in the library, and publish the changes.
Delete the unit from the course.
Without this fix, the ComponentLink will remain and the "Library Updates" tab will show an incorrect number of updates.

Deadline

ASAP, priority for Verawood.

Private ref MNG-4987

@openedx-webhooks

openedx-webhooks commented Jun 26, 2026

Copy link
Copy Markdown

Thanks for the pull request, @bradenmacdonald!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Jun 26, 2026
@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Jun 26, 2026
@bradenmacdonald @claude
test: add a relevant test case and flag overlapping handlers
5c57cae 
Co-Authored-By: Claude <noreply@anthropic.com>
@bradenmacdonald bradenmacdonald force-pushed the braden/38820-fix-componentlink-on-container-delete branch from 35dbaf2 to 5c57cae Compare June 26, 2026 23:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kdmccormick kdmccormick Awaiting requested review from kdmccormick
@navinkarkera navinkarkera Awaiting requested review from navinkarkera

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Contributions
Status: Needs Triage

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Out-of-sync library components counted after unit deletion from course

2 participants

@bradenmacdonald @openedx-webhooks